/*
 * Copyright 2011 ThroughPut, Inc.
 *
 * This is a C++ port of the LMAX Disruptor, originally developed for Java
 * by LMAX Ldt.
 *
 * This port requires the Boost C++ library, as well as boost::atomic, which is
 * available at http://www.chaoticmind.net/~hcb/projects/boost.atomic/.
 * boost::atomic can be replaced with std::atomic if your compiler supports it.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "BatchConsumer.h"
#include "BatchHandler.h"

#ifndef disruptor_SequenceTrackingHandler_h
#define disruptor_SequenceTrackingHandler_h

namespace throughput {
namespace disruptor {
  
  
/**
 * Used by the {@link BatchConsumer} to set a callback allowing the {@link BatchHandler} to notify
 * when it has finished consuming an {@link AbstractEntry} if this happens after the {@link BatchHandler#onAvailable(AbstractEntry)} call.
 * <p>
 * Typically this would be used when the handler is performing some sort of batching operation such are writing to an IO device.
 * </p>
 * @param <T> AbstractEntry implementation storing the data for sharing during exchange or parallel coordination of an event.
 */
template <class Entry>
class SequenceTrackingHandler : public BatchHandler<Entry>
{
  /**
   * Call by the {@link BatchConsumer} to setup the callback.
   *
   * @param sequenceTrackerCallback callback on which to notify the {@link BatchConsumer} that the sequence has progressed.
   */
  virtual void setSequenceTrackerCallback(BatchConsumer<Entry>::SequenceTrackerCallback & sequenceTrackerCallback) = 0;
};

  
  
} //-- end namespace disruptor
} //-- end namespace throughput

#endif
